Add comprehensive CONTRIBUTING.md file with devcontainer support to guide potential contributors #249

Copilot · 2025-08-22T03:35:21Z

Create comprehensive CONTRIBUTING.md file with all essential sections
Address initial feedback (build assets warning, simplified scripts and commits)
Add comprehensive devcontainer documentation and setup instructions
Include GITHUB_TOKEN setup requirements for testing
Update release process to remove npm publication and focus on GitHub Actions workflow
Update all npm test commands to npm run test for consistency and clarity

The CONTRIBUTING.md file now provides complete guidance for contributors with consistent command formatting throughout. All test commands now use the explicit npm run test format for better clarity and consistency.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot · 2025-08-22T03:35:23Z

@virgofx 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

virgofx · 2025-09-29T22:38:10Z

@copilot

Explicitly state do not check in any build/distribution assets (e.g. npm run bundle) this is handled only for releases - testing is sufficient
For key scripts, remove typecheck, bundle, and prettier. add test-watch
for conventional commits, just refer to the website and leave intro overview (don't include subsections, e.g.
format/types/examples)
for PR process, again, remove bundle

Copilot · 2025-09-29T22:40:44Z

@copilot

Explicitly state do not check in any build/distribution assets (e.g. npm run bundle) this is handled only for releases - testing is sufficient

For key scripts, remove typecheck, bundle...

Updated CONTRIBUTING.md to address all your feedback points:

Added explicit warning about not checking in build/distribution assets
Updated key scripts section (removed typecheck, bundle, prettier; added test-watch)
Simplified conventional commits to just reference the site without subsections
Removed bundle from PR process workflow

Changes committed in c3b4906.

virgofx · 2025-09-29T22:44:40Z

@copilot

prior to running tests in the container, ensure you specify and export GITHUB_TOKEN with a generic PAT from your user account.
Additionally, can you provide somewhere near the top instructions for leveraging the built-in devcontainer support. This repo can be started with that.
for the release process, remove npm package publication we don't do that. Instead, focus on saying releases are handled automatically via maintainers via the https://github.com/techpivot/terraform-module-releaser/actions/workflows/release-start.yml Release-Start/ Release workflow. In general, it generates a new pull request that builds (via npm run bundle) the assets, tags the appropriate version and generates a changelog automatically.
add into the getting started section / top - the importance of devcontainers. The devcontainer is preconfigured and is the easiest way to get started. Research https://containers.dev/ and https://code.visualstudio.com/docs/devcontainers/containers to bring any insightful getting started with devcontainers for this project.

CONTRIBUTING.md

Copilot · 2025-09-29T22:49:21Z

@copilot

prior to running tests in the container, ensure you specify and export GITHUB_TOKEN with a generic PAT from your user account.
...

Updated CONTRIBUTING.md with all requested enhancements:

Added comprehensive devcontainer documentation as the recommended setup method with VS Code and Codespaces instructions
Included GITHUB_TOKEN setup requirements in the testing section with export instructions
Updated release process to remove npm package publication and focus on the Release-Start workflow that handles asset building automatically
Reorganized Getting Started section to emphasize devcontainer support while maintaining manual setup option

Changes committed in 1aa4c2e.

virgofx · 2025-09-29T22:50:28Z

@copilot Ensure npm test is npm run test for clarity

Copilot · 2025-09-29T22:53:57Z

@copilot Ensure npm test is npm run test for clarity

Updated all instances of npm test to npm run test throughout the CONTRIBUTING.md file for consistency and clarity. Changed 6 occurrences across different sections including setup verification, development workflow, key scripts, warnings, testing instructions, and PR process.

Changes committed in the latest commit.

virgofx · 2025-09-29T23:04:54Z

@copilot Can you run npm run check:fix to ensure prettier runs and formats required files.

Copilot · 2025-09-29T23:06:49Z

@copilot Can you run npm run check:fix to ensure prettier runs and formats required files.

Ran npm run check:fix successfully. Biome checked 58 files and found no formatting issues - all files are already properly formatted according to the project's standards.

- Covers development environment setup and workflow - Includes commit message guidelines using conventional commits - Provides testing and linting instructions - Details pull request process and code style guidelines - Includes issue reporting and community guidelines - References existing tools and project standards - Formatted according to project's markdown standards Co-authored-by: virgofx <[email protected]>

…sets warning, simplify scripts and commit guidelines Co-authored-by: virgofx <[email protected]>

… setup, and updated release process Co-authored-by: virgofx <[email protected]>

Co-authored-by: virgofx <[email protected]>

github-actions · 2025-09-29T23:19:05Z

📋 Release Plan

Module	Type	Latest Version	New Version	Release Details
`tf-modules-kms`	patch		1.0.0	🆕 Initial Release
`tf-modules-vpc-endpoint`	patch		1.0.0	🆕 Initial Release

📝 Changelog

`tf-modules-kms-1.0.0` (2025-09-29)

🔀PR #249 - Add comprehensive CONTRIBUTING.md file with devcontainer support to guide potential contributors

`tf-modules-vpc-endpoint-1.0.0` (2025-09-29)

🔀PR #249 - Add comprehensive CONTRIBUTING.md file with devcontainer support to guide potential contributors

_{Wiki Status^ℹ️}

✅ Enabled

_{Automated Tag/Release Cleanup^ℹ️}

⏸️ Existing tags and releases will be preserved as the delete-legacy-tags flag is disabled.

_{Powered by: techpivot/terraform-module-releaser}

sonarqubecloud · 2025-09-29T23:19:30Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copilot AI assigned Copilot and virgofx Aug 22, 2025

Copilot started work on behalf of virgofx August 22, 2025 03:35 View session

Copilot AI changed the title ~~[WIP] Add a CONTRIBUTING.md file~~ Add comprehensive CONTRIBUTING.md file to guide potential contributors Aug 22, 2025

Copilot AI requested a review from virgofx August 22, 2025 03:40

Copilot finished work on behalf of virgofx August 22, 2025 03:40

Copilot started work on behalf of virgofx September 29, 2025 22:38 View session

Copilot finished work on behalf of virgofx September 29, 2025 22:41

Copilot started work on behalf of virgofx September 29, 2025 22:44 View session

virgofx reviewed Sep 29, 2025

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

Copilot AI changed the title ~~Add comprehensive CONTRIBUTING.md file to guide potential contributors~~ Add comprehensive CONTRIBUTING.md file with devcontainer support to guide potential contributors Sep 29, 2025

Copilot AI requested a review from virgofx September 29, 2025 22:50

Copilot finished work on behalf of virgofx September 29, 2025 22:50

Copilot started work on behalf of virgofx September 29, 2025 22:50 View session

Copilot finished work on behalf of virgofx September 29, 2025 22:52

Copilot started work on behalf of virgofx September 29, 2025 22:52 View session

Copilot finished work on behalf of virgofx September 29, 2025 22:54

virgofx marked this pull request as ready for review September 29, 2025 23:02

Copilot started work on behalf of virgofx September 29, 2025 23:05 View session

virgofx added the documentation Improvements or additions to documentation label Sep 29, 2025

Copilot finished work on behalf of virgofx September 29, 2025 23:07

Copilot AI and others added 6 commits September 29, 2025 23:08

Initial plan

5e23611

docs: update CONTRIBUTING.md based on feedback - remove build/dist as…

b2576ec

…sets warning, simplify scripts and commit guidelines Co-authored-by: virgofx <[email protected]>

docs: enhance CONTRIBUTING.md with devcontainer support, GITHUB_TOKEN…

386e08d

… setup, and updated release process Co-authored-by: virgofx <[email protected]>

docs: change npm test to npm run test for consistency and clarity

73beb58

Co-authored-by: virgofx <[email protected]>

docs: improve formatting and readability in CONTRIBUTING.md

6dfb9d0

virgofx force-pushed the copilot/fix-10 branch from 3b86035 to 6dfb9d0 Compare September 29, 2025 23:08

docs: standardize numbering and improve clarity in CONTRIBUTING.md

5724746

virgofx force-pushed the copilot/fix-10 branch from 1c78c46 to 5724746 Compare September 29, 2025 23:18

virgofx merged commit bacc3fa into main Sep 29, 2025
25 checks passed

virgofx deleted the copilot/fix-10 branch September 29, 2025 23:21

virgofx mentioned this pull request Sep 29, 2025

Add a CONTRIBUTING.md file #10

Closed

Uh oh!

Add comprehensive CONTRIBUTING.md file with devcontainer support to guide potential contributors #249

Add comprehensive CONTRIBUTING.md file with devcontainer support to guide potential contributors #249

Uh oh!

Conversation

Copilot AI commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI commented Aug 22, 2025

Uh oh!

virgofx commented Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI commented Sep 29, 2025

Uh oh!

virgofx commented Sep 29, 2025

Uh oh!

Uh oh!

Copilot AI commented Sep 29, 2025

Uh oh!

virgofx commented Sep 29, 2025

Uh oh!

Copilot AI commented Sep 29, 2025

Uh oh!

virgofx commented Sep 29, 2025

Uh oh!

Copilot AI commented Sep 29, 2025

Uh oh!

github-actions bot commented Sep 29, 2025

📋 Release Plan

📝 Changelog

tf-modules-kms-1.0.0 (2025-09-29)

tf-modules-vpc-endpoint-1.0.0 (2025-09-29)

Wiki Statusℹ️

Automated Tag/Release Cleanupℹ️

Powered by: techpivot/terraform-module-releaser

Uh oh!

sonarqubecloud bot commented Sep 29, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Aug 22, 2025 •

edited

Loading

virgofx commented Sep 29, 2025 •

edited

Loading

`tf-modules-kms-1.0.0` (2025-09-29)

`tf-modules-vpc-endpoint-1.0.0` (2025-09-29)

_{Wiki Status^ℹ️}

_{Automated Tag/Release Cleanup^ℹ️}

_{Powered by: techpivot/terraform-module-releaser}